Read(Byte[],Byte[],Boolean) Method

Read data from the stream until a delimiter is reached.

[Visual Basic]
Overloads Public Function Read( _
   ByVal buffer() As Byte, _
   ByVal delimiter() As Byte, _
   ByRef found As Boolean _
) As Integer

[C#]
public int Read( 
   byte[] buffer,
   byte[] delimiter,
   ref bool found
);

[C++]
public: int Read( 
   byte[]* buffer,
   byte[]* delimiter,
   ref bool found
) 

[C++/CLI]
public:
int Read( 
   bytearray<buffer>^ buffer,
   bytearray<delimiter>^ delimiter,
   % bool found
) 

Parameters

buffer

The storage location for the received data.

delimiter

The token that is used to determine a segment was read.

found

True if delimiter is found; false otherwise.

Return Type

The total number of bytes read into the buffer, which will normally be less than buffer.length. Returns 0 if end of stream is reached and there is no data left to return.

Exceptions

Remarks

This method reads from the stream and returns when the provided delimiter is found, buffer.length bytes have been read, or end of stream is reached.

The purpose of this method is to provide a convenient way to read a variable-length record from the stream. This is the only kind of Read that uses internal buffering.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

SegmentedStream Class  | SegmentedStream Members  | Overload List